RWTH - Mindstorms NXT Toolbox

Functions - Alphabetical List

CalibrateCompassEnables calibration mode of the HiTechnic compass sensor
checkStatusByteInterpretes the status byte of a return package and creates an error message
CloseSensorCloses a specified sensor port (e.g. turns off the active light mode of the NXT light sensor)
COM_CloseNXTCloses and deletes a specific NXT handle, or clears all existing handles
COM_CollectPacketReads data from a USB or serial/Bluetooth port and retrieves exactly one packet
COM_CreatePacketGenerates a valid Bluetooth packet ready for transmission (i.e. calculates length)
COM_GetDefaultNXTReturns the global default NXT handle if it was previously set
COM_MakeBTConfigFileCreates a Bluetooth configuration file which is needed to open a Bluetooth connection.
COM_OpenNXTOpens a USB or Bluetooth connection to an NXT device and returns a handle for future use
COM_OpenNXTExOpens a Bluetooth or USB connection to an NXT device and returns a handle for future use
COM_ReadI2CRequests and reads sensor data via I2C from a correctly configured digital sensor.
COM_SendPacketSends a communication protocol packet (byte-array) via a USB or Bluetooth channel (serial port)
COM_SetDefaultNXTSets a global default NXT handle that will be used by other functions if no handle is specified.
DebugModeGets or sets the debug state (i.e. if textOut will print messages to the command window)
GetAcceleratorReads the current value of the HiTechnic acceleration sensor
GetCompassReads the current value of the HiTechnic compass sensor
GetInfraredReads the current value of the Hitechnic infrared sensor (infrared seeker)
GetLightReads the current value of the NXT light sensor
GetMemoryCountGets the internal NXT memory counter (manual mapping replica)
GetMotorReads the current motor set by SetMotor(). Raises an error if no motor was set
GetMotorSettingsReturns the current motor data / settings (e.g. position, speed, etc.) from the specified motor
GetSoundReads the current value of the NXT sound sensor
GetSwitchReads the current value of the NXT switch / touch sensor
GetUltrasonicReads the current value of the NXT ultrasonic sensor
MAP_GetCommModuleReads the IO map of the communication module
MAP_GetInputModuleReads the IO map of the input module
MAP_GetOutputModuleReads the IO map of the output module
MAP_GetSoundModuleReads the IO map of the sound module
MAP_GetUIModuleReads the IO map of the user interface module
MAP_SetOutputModuleWrites the IO map to the output module
MOTOR_ASymbolic constant MOTOR_A (returns 0)
MOTOR_BSymbolic constant MOTOR_B (returns 1)
MOTOR_CSymbolic constant MOTOR_C (returns 2)
MotorRotateAbsRotates a motor to an absolute angle
NXT_GetBatteryLevelReturns the current battery level in milli volts
NXT_GetFirmwareVersionReturns the protocol and firmware version of the NXT
NXT_GetInputValuesProcesses a complete sensor reading, i.e. requests input values and collects the answer.
NXT_GetOutputStateRequests and retrieves an output motor state reading
NXT_LSGetStatusGets the number of available bytes from low speed (digital) sensor (e.g. ultrasonic)
NXT_LSReadReads data from a low speed (digital) sensor
NXT_LSWriteWrites the given data to a low speed (digital) sensor
NXT_MessageWriteSends a message to NXT
NXT_PlaySoundFilePlays the given sound file on the NXT Brick
NXT_PlayTonePlays a tone with the given frequency and duration
NXT_ReadIOMapReads the IO map of the given module ID
NXT_ResetInputScaledValueResets the sensors ScaledVal back to 0, depends on currently configured mode (see NXT_SetInputMode)
NXT_ResetMotorPositionResets NXT internal counter for specified motor, relative or absolute counter
NXT_SendKeepAliveSends a KeepAlive packet. Optional: requests sleep time limit.
NXT_SetBrickNameSets a new name for the NXT Brick (connected to the specified handle)
NXT_SetInputModeSets mode, configures and initializes sensor ready to be read out
NXT_SetOutputStateSends previously specified settings to current active motor.
NXT_StartProgramStarts the given program on the NXT Brick
NXT_StopProgramStops a specific program on the NXT Brick
NXT_StopSoundPlaybackStops the current sound playback
NXT_WriteIOMapWrites the IO map to the given module ID
OpenAcceleratorInitializes and sets the mode of the HiTechnic acceleration sensor
OpenCompassInitializes and sets the mode of the HiTechnic magnetic compass sensor
OpenInfraredInitializes and sets the mode of the HiTechnic infrared seeker sensor
OpenLightSets the parameter mode of the NXT light sensor
OpenSoundSets the parameter mode of the NXT sound sensor
OpenSwitchSets the parameter mode of the NXT switch / touch sensor
OpenUltrasonicInitializes and sets the mode of the NXT ultrasonic sensor
OptimizeToolboxPerformanceCopies binary versions of typecastc to toolbox for better performance
readFromIniFileReads parameters from a configuration file (usually *.ini)
ResetMotorAngleResets the relative angle counter for the given motor
SendMotorSettingsSends previously specified settings to current active motor.
SENSOR_1Symbolic constant SENSOR_1 (returns 0)
SENSOR_2Symbolic constant SENSOR_2 (returns 1)
SENSOR_3Symbolic constant SENSOR_3 (returns 2)
SENSOR_4Symbolic constant SENSOR_4 (returns 3)
SetAngleLimitSets the angle limit (in degrees) of the current motor port
SetMemoryCountSets the internal NXT memory counter (manual mapping replica)
SetMotorSets the current motor to use for motor setting commands
SetPowerSets the power of the current active motor
SetRampModeSets the runstate of the current active motor
SetTurnRatioSets the turn ratio of the current active motor
SpeedRegulationEnables / disables the speed regulation mode of the current active motor
StopMotorStops / brakes specified motor. (Synchronisation will be lost after this)
SwitchLampSwitches the LEGO lamp on or off (has to be connected to a motor port)
SyncToMotorEnables synchronization regulation for current active and specified motor
textOutWrapper for fprintf() which can optionally write screen output to a logfile
ticticSimilar to MATLAB's tic(), but extended to save "more states"
toctocSimilar to MATLAB's toc(), but extended to save "more states"
USGetSnapshotResultsRetrieves up to eight echos (distances) stored inside the US sensor
USMakeSnapshotCauses the ultrasonic sensor to send one snapshot ("ping") and record the echos
WaitForMotorPauses execution until specific motor is not running anymore.